/*
 * Copyright (C) 2007-2008 SlideMe client
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.slideme.android.manager.discovery;

import org.kxml2.io.KXmlParser;
import org.xmlpull.v1.XmlPullParserException;

import java.io.IOException;
import java.io.InputStream;

/**
 * Provides services for marshalling from xml to content bundle objects.
 */
public interface BundlesMarshaller {

    /**
     * Returns content bundles from the specified inputStream (xml).
     *
     * @param inputStream the input stream to marshal from
     * @return content bundles from the specified inputStream (xml)
     * @throws IOException if there is a problem marshalling
     */
    ContentBundles marshal(InputStream inputStream) throws IOException;

    public static class Factory {
        /**
         * Constructor
         */
        private Factory() {
        }

        /**
         * Returns a default instance of the bundles marshaller
         *
         * @return a default instance of the bundles marshaller
         */
        public static BundlesMarshaller createDefaultBundlesMarshaller() {
            return new BundlesMarshaller() {
                public ContentBundles marshal(InputStream inputStream) throws IOException {
                    if (inputStream == null) {
                        throw new IllegalArgumentException("BundlesMarshaller.marshal:inputStream");
                    }

                    KXmlParser parser = new KXmlParser();
                    try {
                        parser.setInput(inputStream, null);
                    } catch (XmlPullParserException e) {
                        throw new IOException(e.toString());
                    }

                    return ContentBundles.marshalFrom(parser);
                }
            };
        }
    }
}
